Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove doc generation #86

Merged
merged 1 commit into from
Jun 21, 2024
Merged

remove doc generation #86

merged 1 commit into from
Jun 21, 2024

Conversation

leoromanovsky
Copy link
Member

@leoromanovsky leoromanovsky commented Jun 21, 2024


labels: mergeable

Fixes: #issue

Motivation and Context

These generated docs seem pretty low value, they just explain the types which should be self-evident, and are just causing our PRs to be larger in size then they need to be.

Description

  • remove docs directory
  • remove scripts and dependencies that generate them

How has this been tested?

@leoromanovsky leoromanovsky marked this pull request as ready for review June 21, 2024 18:53
Copy link
Contributor

@sameerank sameerank left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🪓

@leoromanovsky leoromanovsky merged commit b8ceea1 into main Jun 21, 2024
2 checks passed
@leoromanovsky leoromanovsky deleted the lr/remove-docs branch June 21, 2024 19:48
@felipecsl
Copy link
Member

While I understand these were not adding a lot of value as is, I do think some sort of SDK API reference is important to have and we should revisit that in the future maybe. I don't think that just having the official Eppo docs is enough. As an example, here are Stripe's JS SDK API reference: https://docs.stripe.com/terminal/references/api/js-sdk#stripeterminal-create

greghuels added a commit that referenced this pull request Jul 11, 2024
greghuels added a commit that referenced this pull request Jul 11, 2024
* Revert "remove doc generation (#86)"

This reverts commit b8ceea1.

* updated docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants